/*
 * Copyright (c) 2023, Nordic Semiconductor
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of
 * conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
 * of conditions and the following disclaimer in the documentation and/or other materials
 * provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors may be
 * used to endorse or promote products derived from this software without specific prior
 * written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package no.nordicsemi.android.kotlin.ble.mock

import no.nordicsemi.android.kotlin.ble.core.wrapper.IBluetoothGattCharacteristic
import no.nordicsemi.android.kotlin.ble.core.wrapper.IBluetoothGattDescriptor

/**
 * An interface grouping requests.
 */
internal sealed interface MockRequest {

    /**
     * Request id which should be unique for every request.
     */
    val requestId: Int
}

/**
 * An interface grouping requests which require sending response.
 */
internal sealed interface SendResponseRequest : MockRequest

/**
 * A characteristic read request.
 *
 * @property requestId Unique request id.
 * @property characteristic Characteristic id.
 */
internal data class MockCharacteristicRead(
    override val requestId: Int,
    val characteristic: IBluetoothGattCharacteristic,
) : SendResponseRequest

/**
 * A characteristic write request.
 *
 * @property requestId Unique request id.
 * @property characteristic Characteristic id.
 */
internal data class MockCharacteristicWrite(
    override val requestId: Int,
    val characteristic: IBluetoothGattCharacteristic,
) : SendResponseRequest

/**
 * A descriptor read request.
 *
 * @property requestId Unique request id.
 * @property descriptor Descriptor id.
 */
internal data class MockDescriptorRead(
    override val requestId: Int,
    val descriptor: IBluetoothGattDescriptor,
) : SendResponseRequest

/**
 * A descriptor write request.
 *
 * @property requestId Unique request id.
 * @property descriptor Descriptor id.
 */
internal data class MockDescriptorWrite(
    override val requestId: Int,
    val descriptor: IBluetoothGattDescriptor,
) : SendResponseRequest

/**
 * An interface grouping reliable write request which require sending result of the operation.
 */
internal sealed interface ReliableWriteRequest : MockRequest

/**
 * Execute reliable write request.
 *
 * @property requestId Unique request id.
 */
internal data class MockExecuteReliableWrite(
    override val requestId: Int,
) : ReliableWriteRequest

/**
 * Abort reliable write request.
 *
 * @property requestId Unique request id.
 */
internal data class MockAbortReliableWrite(
    override val requestId: Int,
) : ReliableWriteRequest
